-
-
Notifications
You must be signed in to change notification settings - Fork 8.8k
[Fix] Support cls pooling in ModernBertPooler #20067
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @lsz05, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request resolves a critical issue in the ModernBertPooler
by introducing support for cls
pooling, alongside the existing mean
pooling. It enables the pooling method to be configured dynamically based on the model's settings, ensuring compatibility with a wider range of ModernBERT models that rely on cls
pooling for correct operation.
Highlights
- ModernBertPooler Enhancement: The
ModernBertPooler
now dynamically determines the pooling method (mean
orcls
) by reading theclassifier_pooling
attribute from the model's configuration. Previously, it was hardcoded to use onlymean
pooling. - CLS Pooling Support: Implemented support for
cls
pooling, where the pooled output is taken from the first token's hidden state (pooled_output[0, :]
). This addresses an issue where models requiringcls
pooling were not functioning correctly. - Pooling Type Validation: Added validation to ensure that only
cls
ormean
pooling types are accepted, raising aValueError
for any other unsupported types, aligning with Hugging Face Transformers' implementation.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
The pull request introduces support for 'cls' pooling in ModernBertPooler
, addressing the issue where only mean pooling was supported. The changes involve loading the pooling method from the model config and applying it in the forward pass. The implementation includes handling for 'cls' and 'mean' pooling types, with a ValueError raised for unsupported types. The test plan includes test cases for both 'mean' and 'cls' pooling.
else: | ||
raise ValueError(f"Pooling type should be either `cls` or `mean`, but got {self.pooling_type}") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider adding a more descriptive error message that includes the available pooling types to guide users on the expected values.
else: | |
raise ValueError(f"Pooling type should be either `cls` or `mean`, but got {self.pooling_type}") | |
raise ValueError(f"Pooling type should be either `cls` or `mean`, but got {self.pooling_type}. Available pooling types are 'cls' and 'mean'.") |
@@ -258,14 +258,20 @@ def __init__(self, config: ModernBertConfig): | |||
super().__init__() | |||
self.dense = nn.Linear(config.hidden_size, config.hidden_size, | |||
config.classifier_bias) | |||
self.pooling_type = config.classifier_pooling |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's good to see that the pooling type is being loaded from the model config. However, ensure that config.classifier_pooling
is validated elsewhere to prevent unexpected values from being used. If not, consider adding a validation step here or in the config definition to ensure it's one of the supported types (cls
or mean
).
Thanks for fixing! |
Signed-off-by: shengzhe.li <shengzhe.li@sbintuitions.co.jp>
Head branch was pushed to by a user without write access
f23e871
to
bf343f9
Compare
But the implementation of ModernBERT still shows a slight difference from sentence_transformers when lengths > 32. Please help to find out the reasons. |
I tried to print out the outputs of each layer, `transformers` vs `vllm`
|
you might consider using a longer input, You also need to fix pre-commit. |
I use Script: https://gist.github.com/lsz05/a8820632f8d97aee2b6533d97252839d |
Signed-off-by: shengzhe.li <shengzhe.li@sbintuitions.co.jp>
Signed-off-by: shengzhe.li <shengzhe.li@sbintuitions.co.jp>
Signed-off-by: shengzhe.li <shengzhe.li@sbintuitions.co.jp>
Signed-off-by: shengzhe.li <shengzhe.li@sbintuitions.co.jp> Signed-off-by: Will Eaton <weaton@redhat.com>
Signed-off-by: shengzhe.li <shengzhe.li@sbintuitions.co.jp>
Signed-off-by: shengzhe.li <shengzhe.li@sbintuitions.co.jp>
Essential Elements of an Effective PR Description Checklist
supported_models.md
andexamples
for a new model.Purpose
#16648 implemented ModernBERT. However, it supported only mean pooling, causing some models implemented with cls pooling don't work properly.
This PR fixes the issue by loading pooling method from the model config, and then apply it in
ModernBertPooler
.Note that I implement only
cls
andmean
pooling, as huggingface transformers' implementation doesn't support choices other thancls
andmean
. (https://github.com/huggingface/transformers/blob/f4fc42216cd56ab6b68270bf80d811614d8d59e4/src/transformers/models/modernbert/configuration_modernbert.py#L93)Test Plan
Test cases are designed with reference to #16648 (comment).
test code
Test Result
Before this PR:
After this PR:
(Optional) Documentation Update